<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>lib/tty/mouse.h</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.5.7' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='../style.css' />
</head>
<body>
<!-- beginning of fixed guide -->
<div id='guide'><ul>
<li><a href='#TOP'><img class='icon' src='../icons/first.png' alt='[^]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/last.png' alt='[v]' /></a></li>
<li><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a></li>
<li><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a></li>
<li><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a></li>
<li class='standout'><span><a href='../files/lib.html'>lib</a>/<a href='../files/lib--tty.html'>tty</a>/mouse.h</span></li>
</ul></div>
<!-- end of fixed guide -->
<a id='TOP' name='TOP'></a><h2 class='header'><a href='../mains.html'>root</a>/<a href='../files/lib.html'>lib</a>/<a href='../files/lib--tty.html'>tty</a>/mouse.h</h2>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><img class='icon' src='../icons/n_top.png' alt='[top]' /><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+1 lib/tty/mouse.h'  /> */</em>
<hr />
<h2 class='header'><a href='../J/mouse.h.html' title='Multiple included from 14 places.'>INCLUDED FROM</a></h2>
<hr />
<pre>
<a id='L1' name='L1'></a>   1 
<a id='L2' name='L2'></a>   2 <em class='comment'>/** \file mouse.h</em>
<a id='L3' name='L3'></a>   3 <em class='comment'> *  \brief Header: mouse managing</em>
<a id='L4' name='L4'></a>   4 <em class='comment'> *</em>
<a id='L5' name='L5'></a>   5 <em class='comment'> *  Events received by clients of this library have their coordinates 0 based</em>
<a id='L6' name='L6'></a>   6 <em class='comment'> */</em>
<a id='L7' name='L7'></a>   7 
<a id='L8' name='L8'></a>   8 <em class='sharp'>#ifndef</em> <a href='../S/lib--tty--mouse.h.html#L9' title='Defined at 9 in lib/tty/mouse.h.'>MC__MOUSE_H</a>
<a id='L9' name='L9'></a>   9 <em class='sharp'>#define</em> <a href='../S/lib--tty--mouse.h.html#L8' title='Referred from 8 in lib/tty/mouse.h.'>MC__MOUSE_H</a>
<a id='L10' name='L10'></a>  10 
<a id='L11' name='L11'></a>  11 <em class='sharp'>#ifdef</em> <a href='../Y/HAVE_LIBGPM.html' title='Multiple used in 13 places.'>HAVE_LIBGPM</a>
<a id='L12' name='L12'></a>  12 <em class='comment'>/* GPM mouse support include file */</em>
<a id='L13' name='L13'></a>  13 <em class='sharp'>#include</em> &lt;gpm.h&gt;
<a id='L14' name='L14'></a>  14 <em class='sharp'>#endif</em> <em class='comment'>/* !HAVE_LIBGPM */</em>
<a id='L15' name='L15'></a>  15 
<a id='L16' name='L16'></a>  16 
<a id='L17' name='L17'></a>  17 <em class='comment'>/*** typedefs(not structures) and defined constants **********************************************/</em>
<a id='L18' name='L18'></a>  18 
<a id='L19' name='L19'></a>  19 <em class='sharp'>#ifndef</em> <a href='../Y/HAVE_LIBGPM.html' title='Multiple used in 13 places.'>HAVE_LIBGPM</a>
<a id='L20' name='L20'></a>  20 <em class='comment'>/* Equivalent definitions for non-GPM mouse support */</em>
<a id='L21' name='L21'></a>  21 <em class='comment'>/* These lines are modified version from the lines appearing in the */</em>
<a id='L22' name='L22'></a>  22 <em class='comment'>/* gpm.h include file of the Linux General Purpose Mouse server */</em>
<a id='L23' name='L23'></a>  23 
<a id='L24' name='L24'></a>  24 <em class='sharp'>#define</em> <a href='../R/GPM_B_LEFT.html' title='Multiple referred from 2 places.'>GPM_B_LEFT</a>      (1 &lt;&lt; 2)
<a id='L25' name='L25'></a>  25 <em class='sharp'>#define</em> <a href='../R/GPM_B_MIDDLE.html' title='Multiple referred from 2 places.'>GPM_B_MIDDLE</a>    (1 &lt;&lt; 1)
<a id='L26' name='L26'></a>  26 <em class='sharp'>#define</em> <a href='../R/GPM_B_RIGHT.html' title='Multiple referred from 3 places.'>GPM_B_RIGHT</a>     (1 &lt;&lt; 0)
<a id='L27' name='L27'></a>  27 
<a id='L28' name='L28'></a>  28 <em class='sharp'>#define</em> GPM_BARE_EVENTS(<a href='../Y/ev.html' title='Multiple used in 39 places.'>ev</a>) ((<a href='../Y/ev.html' title='Multiple used in 39 places.'>ev</a>)&amp;0xF)
<a id='L29' name='L29'></a>  29 <em class='sharp'>#endif</em> <em class='comment'>/* !HAVE_LIBGPM */</em>
<a id='L30' name='L30'></a>  30 
<a id='L31' name='L31'></a>  31 <em class='comment'>/* Mouse wheel events */</em>
<a id='L32' name='L32'></a>  32 <em class='sharp'>#ifndef</em> <a href='../S/lib--tty--mouse.h.html#L33' title='Defined at 33 in lib/tty/mouse.h.'>GPM_B_DOWN</a>
<a id='L33' name='L33'></a>  33 <em class='sharp'>#define</em> <a href='../R/GPM_B_DOWN.html' title='Multiple referred from 4 places.'>GPM_B_DOWN</a>      (1 &lt;&lt; 5)
<a id='L34' name='L34'></a>  34 <em class='sharp'>#endif</em>
<a id='L35' name='L35'></a>  35 
<a id='L36' name='L36'></a>  36 <em class='sharp'>#ifndef</em> <a href='../S/lib--tty--mouse.h.html#L37' title='Defined at 37 in lib/tty/mouse.h.'>GPM_B_UP</a>
<a id='L37' name='L37'></a>  37 <em class='sharp'>#define</em> <a href='../R/GPM_B_UP.html' title='Multiple referred from 4 places.'>GPM_B_UP</a>        (1 &lt;&lt; 4)
<a id='L38' name='L38'></a>  38 <em class='sharp'>#endif</em>
<a id='L39' name='L39'></a>  39 
<a id='L40' name='L40'></a>  40 <em class='comment'>/*** enums ***************************************************************************************/</em>
<a id='L41' name='L41'></a>  41 
<a id='L42' name='L42'></a>  42 <em class='sharp'>#ifndef</em> <a href='../Y/HAVE_LIBGPM.html' title='Multiple used in 13 places.'>HAVE_LIBGPM</a>
<a id='L43' name='L43'></a>  43 <em class='comment'>/* Xterm mouse support supports only GPM_DOWN and GPM_UP */</em>
<a id='L44' name='L44'></a>  44 <em class='comment'>/* If you use others make sure your code also works without them */</em>
<a id='L45' name='L45'></a>  45 <strong class='reserved'>enum</strong> <a href='../S/lib--tty--mouse.h.html#L88' title='Referred from 88 in lib/tty/mouse.h.'>Gpm_Etype</a>
<a id='L46' name='L46'></a>  46 <em class='brace'>{</em>
<a id='L47' name='L47'></a>  47     <a href='../R/GPM_MOVE.html' title='Multiple referred from 3 places.'>GPM_MOVE</a> = 1,
<a id='L48' name='L48'></a>  48     <a href='../R/GPM_DRAG.html' title='Multiple referred from 2 places.'>GPM_DRAG</a> = 2,               <em class='comment'>/* exactly one in four is active at a time */</em>
<a id='L49' name='L49'></a>  49     <a href='../R/GPM_DOWN.html' title='Multiple referred from 2 places.'>GPM_DOWN</a> = 4,
<a id='L50' name='L50'></a>  50     <a href='../R/GPM_UP.html' title='Multiple referred from 2 places.'>GPM_UP</a> = 8,
<a id='L51' name='L51'></a>  51 
<a id='L52' name='L52'></a>  52 
<a id='L53' name='L53'></a>  53     <a href='../R/GPM_SINGLE.html' title='Multiple referred from 2 places.'>GPM_SINGLE</a> = 16,            <em class='comment'>/* at most one in three is set */</em>
<a id='L54' name='L54'></a>  54     <a href='../R/GPM_DOUBLE.html' title='Multiple referred from 6 places.'>GPM_DOUBLE</a> = 32,
<a id='L55' name='L55'></a>  55     <a href='../R/GPM_TRIPLE.html' title='Multiple referred from 2 places.'>GPM_TRIPLE</a> = 64,
<a id='L56' name='L56'></a>  56 
<a id='L57' name='L57'></a>  57     GPM_MFLAG = 128,            <em class='comment'>/* motion during click? */</em>
<a id='L58' name='L58'></a>  58     GPM_HARD = 256              <em class='comment'>/* if set in the defaultMask, force an already</em>
<a id='L59' name='L59'></a>  59 <em class='comment'>                                   used event to pass over to another handler */</em>
<a id='L60' name='L60'></a>  60 <em class='brace'>}</em>;
<a id='L61' name='L61'></a>  61 <em class='sharp'>#endif</em> <em class='comment'>/* !HAVE_LIBGPM */</em>
<a id='L62' name='L62'></a>  62 
<a id='L63' name='L63'></a>  63 <em class='comment'>/* Constants returned from the mouse callback */</em>
<a id='L64' name='L64'></a>  64 <strong class='reserved'>enum</strong>
<a id='L65' name='L65'></a>  65 <em class='brace'>{</em>
<a id='L66' name='L66'></a>  66     <a href='../R/MOU_UNHANDLED.html' title='Multiple referred from 6 places.'>MOU_UNHANDLED</a> = 0,
<a id='L67' name='L67'></a>  67     <a href='../S/lib--widget--mouse.c.html#L196' title='Referred from 196 in lib/widget/mouse.c.'>MOU_NORMAL</a>,
<a id='L68' name='L68'></a>  68     <a href='../R/MOU_REPEAT.html' title='Multiple referred from 3 places.'>MOU_REPEAT</a>
<a id='L69' name='L69'></a>  69 <em class='brace'>}</em>;
<a id='L70' name='L70'></a>  70 
<a id='L71' name='L71'></a>  71 <em class='comment'>/* Type of mouse support */</em>
<a id='L72' name='L72'></a>  72 <strong class='reserved'>typedef</strong> <strong class='reserved'>enum</strong>
<a id='L73' name='L73'></a>  73 <em class='brace'>{</em>
<a id='L74' name='L74'></a>  74     <a href='../R/MOUSE_NONE.html' title='Multiple referred from 6 places.'>MOUSE_NONE</a>,                 <em class='comment'>/* Not detected yet */</em>
<a id='L75' name='L75'></a>  75     <a href='../R/MOUSE_DISABLED.html' title='Multiple referred from 4 places.'>MOUSE_DISABLED</a>,             <em class='comment'>/* Explicitly disabled by -d */</em>
<a id='L76' name='L76'></a>  76     <a href='../R/MOUSE_GPM.html' title='Multiple referred from 7 places.'>MOUSE_GPM</a>,                  <em class='comment'>/* Support using GPM on Linux */</em>
<a id='L77' name='L77'></a>  77     <a href='../S/lib--tty--mouse.h.html#L78' title='Referred from 78 in lib/tty/mouse.h.'>MOUSE_XTERM</a>,                <em class='comment'>/* Support using xterm-style mouse reporting */</em>
<a id='L78' name='L78'></a>  78     <a href='../R/MOUSE_XTERM_NORMAL_TRACKING.html' title='Multiple referred from 5 places.'>MOUSE_XTERM_NORMAL_TRACKING</a> = <a href='../S/lib--tty--mouse.h.html#L77' title='Defined at 77 in lib/tty/mouse.h.'>MOUSE_XTERM</a>,
<a id='L79' name='L79'></a>  79     <a href='../R/MOUSE_XTERM_BUTTON_EVENT_TRACKING.html' title='Multiple referred from 4 places.'>MOUSE_XTERM_BUTTON_EVENT_TRACKING</a>
<a id='L80' name='L80'></a>  80 <em class='brace'>}</em> <a href='../R/Mouse_Type.html' title='Multiple referred from 2 places.'>Mouse_Type</a>;
<a id='L81' name='L81'></a>  81 
<a id='L82' name='L82'></a>  82 <em class='comment'>/*** structures declarations (and typedefs of structures)*****************************************/</em>
<a id='L83' name='L83'></a>  83 
<a id='L84' name='L84'></a>  84 <em class='sharp'>#ifndef</em> <a href='../Y/HAVE_LIBGPM.html' title='Multiple used in 13 places.'>HAVE_LIBGPM</a>
<a id='L85' name='L85'></a>  85 <strong class='reserved'>typedef</strong> <strong class='reserved'>struct</strong> <a href='../R/Gpm_Event.html' title='Multiple referred from 27 places.'>Gpm_Event</a>
<a id='L86' name='L86'></a>  86 <em class='brace'>{</em>
<a id='L87' name='L87'></a>  87     <strong class='reserved'>int</strong> <a href='../Y/buttons.html' title='Multiple used in 21 places.'>buttons</a>, <a href='../Y/x.html' title='Multiple used in 769 places.'>x</a>, <a href='../Y/y.html' title='Multiple used in 658 places.'>y</a>;
<a id='L88' name='L88'></a>  88     <strong class='reserved'>enum</strong> <a href='../S/lib--tty--mouse.h.html#L45' title='Defined at 45 in lib/tty/mouse.h.'>Gpm_Etype</a> <a href='../Y/type.html' title='Multiple used in 300 places.'>type</a>;
<a id='L89' name='L89'></a>  89 <em class='brace'>}</em> <a href='../R/Gpm_Event.html' title='Multiple referred from 27 places.'>Gpm_Event</a>;
<a id='L90' name='L90'></a>  90 <em class='sharp'>#endif</em> <em class='comment'>/* !HAVE_LIBGPM */</em>
<a id='L91' name='L91'></a>  91 
<a id='L92' name='L92'></a>  92 <em class='comment'>/*** global variables defined in .c file *********************************************************/</em>
<a id='L93' name='L93'></a>  93 
<a id='L94' name='L94'></a>  94 <em class='comment'>/* Type of the currently used mouse */</em>
<a id='L95' name='L95'></a>  95 <strong class='reserved'>extern</strong> <a href='../S/lib--tty--mouse.h.html#L80' title='Defined at 80 in lib/tty/mouse.h.'>Mouse_Type</a> <a href='../Y/use_mouse_p.html' title='Multiple used in 21 places.'>use_mouse_p</a>;
<a id='L96' name='L96'></a>  96 
<a id='L97' name='L97'></a>  97 <em class='comment'>/* To be used when gpm_fd were initially &gt;= 0 */</em>
<a id='L98' name='L98'></a>  98 <strong class='reserved'>extern</strong> <strong class='reserved'>int</strong> <a href='../Y/mouse_fd.html' title='Multiple used in 18 places.'>mouse_fd</a>;
<a id='L99' name='L99'></a>  99 
<a id='L100' name='L100'></a> 100 <em class='comment'>/* String indicating that a mouse event has occurred, usually "\E[M" */</em>
<a id='L101' name='L101'></a> 101 <strong class='reserved'>extern</strong> <strong class='reserved'>const</strong> <strong class='reserved'>char</strong> *<a href='../Y/xmouse_seq.html' title='Multiple used in 13 places.'>xmouse_seq</a>;
<a id='L102' name='L102'></a> 102 
<a id='L103' name='L103'></a> 103 <em class='comment'>/* String indicating that an SGR extended mouse event has occurred, namely "\E[&lt;" */</em>
<a id='L104' name='L104'></a> 104 <strong class='reserved'>extern</strong> <strong class='reserved'>const</strong> <strong class='reserved'>char</strong> *<a href='../Y/xmouse_extended_seq.html' title='Multiple used in 6 places.'>xmouse_extended_seq</a>;
<a id='L105' name='L105'></a> 105 
<a id='L106' name='L106'></a> 106 <em class='comment'>/*** declarations of public functions ************************************************************/</em>
<a id='L107' name='L107'></a> 107 
<a id='L108' name='L108'></a> 108 <em class='comment'>/* General (i.e. both for xterm and gpm) mouse support definitions */</em>
<a id='L109' name='L109'></a> 109 
<a id='L110' name='L110'></a> 110 <strong class='reserved'>void</strong> <a href='../S/lib--tty--mouse.c.html#L81' title='Defined at 81 in lib/tty/mouse.c.'>init_mouse</a> (<strong class='reserved'>void</strong>);
<a id='L111' name='L111'></a> 111 <strong class='reserved'>void</strong> <a href='../S/lib--tty--mouse.c.html#L109' title='Defined at 109 in lib/tty/mouse.c.'>enable_mouse</a> (<strong class='reserved'>void</strong>);
<a id='L112' name='L112'></a> 112 <strong class='reserved'>void</strong> <a href='../S/lib--tty--mouse.c.html#L173' title='Defined at 173 in lib/tty/mouse.c.'>disable_mouse</a> (<strong class='reserved'>void</strong>);
<a id='L113' name='L113'></a> 113 
<a id='L114' name='L114'></a> 114 <strong class='reserved'>void</strong> <a href='../S/lib--tty--mouse.c.html#L67' title='Defined at 67 in lib/tty/mouse.c.'>show_mouse_pointer</a> (<strong class='reserved'>int</strong> <a href='../Y/x.html' title='Multiple used in 769 places.'>x</a>, <strong class='reserved'>int</strong> <a href='../Y/y.html' title='Multiple used in 658 places.'>y</a>);
<a id='L115' name='L115'></a> 115 
<a id='L116' name='L116'></a> 116 <em class='comment'>/*** inline functions ****************************************************************************/</em>
<a id='L117' name='L117'></a> 117 <em class='sharp'>#endif</em> <em class='comment'>/* MC_MOUSE_H */</em>
</pre>
<hr />
<a id='BOTTOM' name='BOTTOM'></a>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a><img class='icon' src='../icons/n_bottom.png' alt='[bottom]' /><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+117 lib/tty/mouse.h'  /> */</em>
</body>
</html>
